Add emoji support to docs using sphinxemoji ✨#1006
Conversation
|
Thanks for the pull request, @skylentshore! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
|
Hi! The Read the Docs build failed because the new extension ( CLA has been signed ✅ |
|
Thanks for this contribution, @skylentshore! Did you receive a fully executed version of the CLA form? Or was it submitted today? The turnaround is about 24 hours. If you haven't heard within a few days, please let me know! |
mphilbrick211
moved this from Needs Triage
to Needs Tests Run or CLA Signed
in Contributions
|
Hi @skylentshore - thanks for the contribution! You shouldn't need to check in the build files. I would expect the diff to look similar to this one, where we added the 404 extension: #850 |
sarina
moved this from Needs Tests Run or CLA Signed
to Waiting on Author
in Contributions
|
Hi @skylentshore - I'd recommend closing this PR and starting a new one. Adding support should be very simple:
Then, try adding an emoji to a page in a separate commit, so we can test that it works. |
github-project-automation
Bot
moved this from Waiting on Author
to Done
in Contributions
4 participants
This PR adds emoji support to the Open edX documentation via sphinxemoji, enabling use of emojis in .rst files with the |:emoji:| syntax.
The conf.py is updated to include the extension.
Style is set to 'twemoji' for consistency.
A sample line using emojis has been added to the top of index.rst to demonstrate functionality. Happy to remove or relocate that as needed.
All supporting extensions and themes were confirmed working locally.